<!doctype html>
<html class="default no-js">
<head>
	<meta charset="utf-8">
	<meta http-equiv="X-UA-Compatible" content="IE=edge">
	<title>&quot;coconet/coconet_utils&quot; | @magenta/music</title>
	<meta name="description" content="">
	<meta name="viewport" content="width=device-width, initial-scale=1">
	<link rel="stylesheet" href="../assets/css/main.css">
</head>
<body>
<header>
	<div class="tsd-page-toolbar">
		<div class="container">
			<div class="table-wrap">
				<div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
					<div class="field">
						<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
						<input id="tsd-search-field" type="text" />
					</div>
					<ul class="results">
						<li class="state loading">Preparing search index...</li>
						<li class="state failure">The search index is not available</li>
					</ul>
					<a href="../index.html" class="title">@magenta/music</a>
				</div>
				<div class="table-cell" id="tsd-widgets">
					<div id="tsd-filter">
						<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
						<div class="tsd-filter-group">
							<div class="tsd-select" id="tsd-filter-visibility">
								<span class="tsd-select-label">All</span>
								<ul class="tsd-select-list">
									<li data-value="public">Public</li>
									<li data-value="protected">Public/Protected</li>
									<li data-value="private" class="selected">All</li>
								</ul>
							</div>
							<input type="checkbox" id="tsd-filter-inherited" checked />
							<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
							<input type="checkbox" id="tsd-filter-only-exported" />
							<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
						</div>
					</div>
					<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
				</div>
			</div>
		</div>
	</div>
	<div class="tsd-page-title">
		<div class="container">
			<ul class="tsd-breadcrumb">
				<li>
					<a href="../globals.html">Globals</a>
				</li>
				<li>
					<a href="_coconet_coconet_utils_.html">&quot;coconet/coconet_utils&quot;</a>
				</li>
			</ul>
			<h1>External module &quot;coconet/coconet_utils&quot;</h1>
		</div>
	</div>
</header>
<div class="container container-main">
	<div class="row">
		<div class="col-8 col-content">
			<section class="tsd-panel tsd-comment">
				<div class="tsd-comment tsd-typography">
					<div class="lead">
						<p>Utility functions for the [Coconet]{@link} model.</p>
					</div>
					<dl class="tsd-comment-tags">
						<dt>license</dt>
						<dd><p>Copyright 2019 Google Inc. All Rights Reserved.
								Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);
								you may not use this file except in compliance with the License.
							You may obtain a copy of the License at</p>
							<p><a href="http://www.apache.org/licenses/LICENSE-2.0">http://www.apache.org/licenses/LICENSE-2.0</a></p>
							<p>Unless required by applicable law or agreed to in writing, software
								distributed under the License is distributed on an &quot;AS IS&quot; BASIS,
								WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
								See the License for the specific language governing permissions and
							limitations under the License.</p>
						</dd>
					</dl>
				</div>
			</section>
			<section class="tsd-panel-group tsd-index-group">
				<h2>Index</h2>
				<section class="tsd-panel tsd-index-panel">
					<div class="tsd-index-content">
						<section class="tsd-index-section ">
							<h3>Variables</h3>
							<ul class="tsd-index-list">
								<li class="tsd-kind-variable tsd-parent-kind-external-module"><a href="_coconet_coconet_utils_.html#is_ios" class="tsd-kind-icon">IS_<wbr>IOS</a></li>
								<li class="tsd-kind-variable tsd-parent-kind-external-module"><a href="_coconet_coconet_utils_.html#min_pitch" class="tsd-kind-icon">MIN_<wbr>PITCH</a></li>
								<li class="tsd-kind-variable tsd-parent-kind-external-module"><a href="_coconet_coconet_utils_.html#num_pitches" class="tsd-kind-icon">NUM_<wbr>PITCHES</a></li>
								<li class="tsd-kind-variable tsd-parent-kind-external-module"><a href="_coconet_coconet_utils_.html#num_voices" class="tsd-kind-icon">NUM_<wbr>VOICES</a></li>
							</ul>
						</section>
						<section class="tsd-index-section ">
							<h3>Functions</h3>
							<ul class="tsd-index-list">
								<li class="tsd-kind-function tsd-parent-kind-external-module"><a href="_coconet_coconet_utils_.html#pianorolltosequence" class="tsd-kind-icon">pianoroll<wbr>ToSequence</a></li>
								<li class="tsd-kind-function tsd-parent-kind-external-module"><a href="_coconet_coconet_utils_.html#sequencetopianoroll" class="tsd-kind-icon">sequence<wbr>ToPianoroll</a></li>
							</ul>
						</section>
					</div>
				</section>
			</section>
			<section class="tsd-panel-group tsd-member-group ">
				<h2>Variables</h2>
				<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-external-module">
					<a name="is_ios" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagConst">Const</span> IS_<wbr>IOS</h3>
					<div class="tsd-signature tsd-kind-icon">IS_<wbr>IOS<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> =&nbsp;/iPad|iPhone|iPod/.test(navigator.userAgent)</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/tensorflow/magenta-js/tree/master/music/src/coconet/coconet_utils.ts#L27">coconet/coconet_utils.ts:27</a></li>
						</ul>
					</aside>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-external-module">
					<a name="min_pitch" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagConst">Const</span> MIN_<wbr>PITCH</h3>
					<div class="tsd-signature tsd-kind-icon">MIN_<wbr>PITCH<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">36</span><span class="tsd-signature-symbol"> =&nbsp;36</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/tensorflow/magenta-js/tree/master/music/src/coconet/coconet_utils.ts#L32">coconet/coconet_utils.ts:32</a></li>
						</ul>
					</aside>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-external-module">
					<a name="num_pitches" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagConst">Const</span> NUM_<wbr>PITCHES</h3>
					<div class="tsd-signature tsd-kind-icon">NUM_<wbr>PITCHES<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">46</span><span class="tsd-signature-symbol"> =&nbsp;46</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/tensorflow/magenta-js/tree/master/music/src/coconet/coconet_utils.ts#L30">coconet/coconet_utils.ts:30</a></li>
						</ul>
					</aside>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-external-module">
					<a name="num_voices" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagConst">Const</span> NUM_<wbr>VOICES</h3>
					<div class="tsd-signature tsd-kind-icon">NUM_<wbr>VOICES<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">4</span><span class="tsd-signature-symbol"> =&nbsp;4</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/tensorflow/magenta-js/tree/master/music/src/coconet/coconet_utils.ts#L35">coconet/coconet_utils.ts:35</a></li>
						</ul>
					</aside>
				</section>
			</section>
			<section class="tsd-panel-group tsd-member-group ">
				<h2>Functions</h2>
				<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module">
					<a name="pianorolltosequence" class="tsd-anchor"></a>
					<h3>pianoroll<wbr>ToSequence</h3>
					<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module">
						<li class="tsd-signature tsd-kind-icon">pianoroll<wbr>ToSequence<span class="tsd-signature-symbol">(</span>pianoroll<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">tf.Tensor4D</span>, numberOfSteps<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">NoteSequence</span></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in <a href="https://github.com/tensorflow/magenta-js/tree/master/music/src/coconet/coconet_utils.ts#L49">coconet/coconet_utils.ts:49</a></li>
								</ul>
							</aside>
							<div class="tsd-comment tsd-typography">
								<div class="lead">
									<p>Converts a pianoroll representation to a <code>NoteSequence</code>. Note that since
										the pianoroll representation can&#39;t distinguish between multiple eighth notes
									and held notes, the resulting <code>NoteSequence</code> won&#39;t either.</p>
								</div>
							</div>
							<h4 class="tsd-parameters-title">Parameters</h4>
							<ul class="tsd-parameters">
								<li>
									<h5>pianoroll: <span class="tsd-signature-type">tf.Tensor4D</span></h5>
									<div class="tsd-comment tsd-typography">
										<p>Tensor of shape <code>[steps][NUM_PITCHES][NUM_VOICES]</code>,
											where each entry represents an instrument being played at a particular step
											and for a particular pitch. For example, <code>pianoroll[0][64] =[0, 0, 1, 0]</code>
										means that the third instrument plays pitch 64 at time 0.</p>
									</div>
								</li>
								<li>
									<h5>numberOfSteps: <span class="tsd-signature-type">number</span></h5>
									<div class="tsd-comment tsd-typography">
										<p>The number of quantized steps in the sequence.</p>
									</div>
								</li>
							</ul>
							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">NoteSequence</span></h4>
							<p>A <code>NoteSequence</code>.</p>
						</li>
					</ul>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module">
					<a name="sequencetopianoroll" class="tsd-anchor"></a>
					<h3>sequence<wbr>ToPianoroll</h3>
					<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module">
						<li class="tsd-signature tsd-kind-icon">sequence<wbr>ToPianoroll<span class="tsd-signature-symbol">(</span>ns<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">INoteSequence</span>, numberOfSteps<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">tf.Tensor4D</span></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in <a href="https://github.com/tensorflow/magenta-js/tree/master/music/src/coconet/coconet_utils.ts#L98">coconet/coconet_utils.ts:98</a></li>
								</ul>
							</aside>
							<div class="tsd-comment tsd-typography">
								<div class="lead">
									<p>Converts a <code>NoteSequence</code> to a pianoroll representation. This sequence
										needs to contain notes with a valid set of instruments, representing the
										voices in a Bach harmony: 0 is Soprano, 1 is Alto, 2 Tenor and 3 Bass. Any
										notes with instruments outside of this range are ignored. Note that this
										pianoroll representation can&#39;t distinguish between multiple eighth notes and
									held notes, so that information will be lost.</p>
								</div>
							</div>
							<h4 class="tsd-parameters-title">Parameters</h4>
							<ul class="tsd-parameters">
								<li>
									<h5>ns: <span class="tsd-signature-type">INoteSequence</span></h5>
									<div class="tsd-comment tsd-typography">
										<p>A quantized <code>NoteSequence</code> with at least one note.</p>
									</div>
								</li>
								<li>
									<h5>numberOfSteps: <span class="tsd-signature-type">number</span></h5>
									<div class="tsd-comment tsd-typography">
										<p>The number of quantized steps in the sequence.</p>
									</div>
								</li>
							</ul>
							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">tf.Tensor4D</span></h4>
							<p>A Tensor of shape <code>[numberOfSteps][NUM_PITCHES][NUM_VOICES]</code>
								where each entry represents an instrument being played at a particular
								step and for a particular pitch. For example,
								<code>pianoroll[0][64] = [0, 0, 1, 0]</code> means that the third instrument plays
							pitch 64 at time 0.</p>
						</li>
					</ul>
				</section>
			</section>
		</div>
		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
			<nav class="tsd-navigation primary">
				<ul>
					<li class="globals  ">
						<a href="../globals.html"><em>Globals</em></a>
					</li>
					<li class="current tsd-kind-external-module">
						<a href="_coconet_coconet_utils_.html">"coconet/coconet_<wbr>utils"</a>
					</li>
				</ul>
			</nav>
			<nav class="tsd-navigation secondary menu-sticky">
				<ul class="before-current">
					<li class=" tsd-kind-variable tsd-parent-kind-external-module">
						<a href="_coconet_coconet_utils_.html#is_ios" class="tsd-kind-icon">IS_<wbr>IOS</a>
					</li>
					<li class=" tsd-kind-variable tsd-parent-kind-external-module">
						<a href="_coconet_coconet_utils_.html#min_pitch" class="tsd-kind-icon">MIN_<wbr>PITCH</a>
					</li>
					<li class=" tsd-kind-variable tsd-parent-kind-external-module">
						<a href="_coconet_coconet_utils_.html#num_pitches" class="tsd-kind-icon">NUM_<wbr>PITCHES</a>
					</li>
					<li class=" tsd-kind-variable tsd-parent-kind-external-module">
						<a href="_coconet_coconet_utils_.html#num_voices" class="tsd-kind-icon">NUM_<wbr>VOICES</a>
					</li>
					<li class=" tsd-kind-function tsd-parent-kind-external-module">
						<a href="_coconet_coconet_utils_.html#pianorolltosequence" class="tsd-kind-icon">pianoroll<wbr>ToSequence</a>
					</li>
					<li class=" tsd-kind-function tsd-parent-kind-external-module">
						<a href="_coconet_coconet_utils_.html#sequencetopianoroll" class="tsd-kind-icon">sequence<wbr>ToPianoroll</a>
					</li>
				</ul>
			</nav>
		</div>
	</div>
</div>
<footer class="with-border-bottom">
	<div class="container">
		<h2>Legend</h2>
		<div class="tsd-legend-group">
			<ul class="tsd-legend">
				<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
				<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
				<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
				<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
				<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
				<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
				<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
				<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
				<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
				<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
				<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
				<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
				<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
				<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
				<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
				<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
				<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
				<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
			</ul>
		</div>
	</div>
</footer>
<div class="container tsd-generator">
	<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
</body>
</html>